IndexOfMaximum Generic Method

Wintellect PowerCollections

Collapse imageExpand ImageCollapseAll imageExpandAll imageDropDown imageDropDownHover imageCopy imageCopyHover image
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Finds the index of the maximum value in a list.

Namespace: Wintellect.PowerCollections
Assembly:  PowerCollections (in PowerCollections.dll)

Syntax

C#
public static int IndexOfMaximum<T>(
	IList<T> list
) where T : IComparable<T>
Visual Basic (Declaration)
Public Shared Function IndexOfMaximum(Of T As IComparable(Of T)) ( _
	list As IList(Of T) _
) As Integer
Visual C++
public:
generic<typename T>
where T : IComparable<T>
static int IndexOfMaximum (
	IList<T>^ list
)

Parameters

list
IList<(Of <T>)>
The list to search.

Return Value

The index of the largest item in the list. If the maximum value appears multiple times, the index of the first appearance is used. If the list is empty, -1 is returned.

Type Parameters

T
The type of items in the list.

Remarks

Values in the list are compared by using the IComparable<T> interfaces implementation on the type T.

Exceptions

ExceptionCondition
System..::ArgumentNullExceptionlist is null.

See Also